light6.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef LIGHT6_H
#define LIGHT6_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"




#define LIGHT6_REG_ALS_CONF                     0x00
#define LIGHT6_REG_ALS_THDH_L                   0x04
#define LIGHT6_REG_ALS_THDH_H                   0x05
#define LIGHT6_REG_ALS_THDL_L                   0x06
#define LIGHT6_REG_ALS_THDL_H                   0x07
#define LIGHT6_REG_ALS_DATA_L                   0x10
#define LIGHT6_REG_ALS_DATA_H                   0x11
#define LIGHT6_REG_IR_DATA_L                    0x12
#define LIGHT6_REG_IR_DATA_H                    0x13
#define LIGHT6_REG_VEML6031X01_ID_L             0x14
#define LIGHT6_REG_VEML6031X01_ID_H             0x15
#define LIGHT6_REG_INT_FLAG                     0x17
 // light6_reg



#define LIGHT6_ALS_CONFIG_ALS_IT_3_125_MS       0x0000
#define LIGHT6_ALS_CONFIG_ALS_IT_6_25_MS        0x1000
#define LIGHT6_ALS_CONFIG_ALS_IT_12_5_MS        0x2000
#define LIGHT6_ALS_CONFIG_ALS_IT_25_MS          0x3000
#define LIGHT6_ALS_CONFIG_ALS_IT_50_MS          0x4000
#define LIGHT6_ALS_CONFIG_ALS_IT_100_MS         0x5000
#define LIGHT6_ALS_CONFIG_ALS_IT_200_MS         0x6000
#define LIGHT6_ALS_CONFIG_ALS_IT_400_MS         0x7000
#define LIGHT6_ALS_CONFIG_ALS_IT_MASK           0x7000
#define LIGHT6_ALS_CONFIG_ALS_MODE_AUTO         0x0000
#define LIGHT6_ALS_CONFIG_ALS_MODE_ACTIVE_FORCE 0x0800
#define LIGHT6_ALS_CONFIG_ALS_MODE_MASK         0x0800
#define LIGHT6_ALS_CONFIG_ALS_TRIGGER_OFF       0x0000
#define LIGHT6_ALS_CONFIG_ALS_TRIGGER_ON        0x0400
#define LIGHT6_ALS_CONFIG_ALS_TRIGGER_MASK      0x0400
#define LIGHT6_ALS_CONFIG_ALS_INT_OFF           0x0000
#define LIGHT6_ALS_CONFIG_ALS_INT_ON            0x0200
#define LIGHT6_ALS_CONFIG_ALS_INT_MASK          0x0200
#define LIGHT6_ALS_CONFIG_ALS_ON_TURN_ON        0x0000
#define LIGHT6_ALS_CONFIG_ALS_ON_TURN_OFF       0x0180
#define LIGHT6_ALS_CONFIG_ALS_ON_MASK           0x0180
#define LIGHT6_ALS_CONFIG_ALS_PDDIV_4_4_PD      0x0000
#define LIGHT6_ALS_CONFIG_ALS_PDDIV_1_4_PD      0x0040
#define LIGHT6_ALS_CONFIG_ALS_PDDIV_MASK        0x0040
#define LIGHT6_ALS_CONFIG_ALS_GAIN_X1           0x0000
#define LIGHT6_ALS_CONFIG_ALS_GAIN_X2           0x0008
#define LIGHT6_ALS_CONFIG_ALS_GAIN_X0_66        0x0010
#define LIGHT6_ALS_CONFIG_ALS_GAIN_X0_5         0x0018
#define LIGHT6_ALS_CONFIG_ALS_GAIN_MASK         0x0018
#define LIGHT6_ALS_CONFIG_ALS_PERS_1            0x0000
#define LIGHT6_ALS_CONFIG_ALS_PERS_2            0x0002
#define LIGHT6_ALS_CONFIG_ALS_PERS_4            0x0004
#define LIGHT6_ALS_CONFIG_ALS_PERS_8            0x0006
#define LIGHT6_ALS_CONFIG_ALS_PERS_MASK         0x0006
#define LIGHT6_ALS_CONFIG_ALS_CAL_OFF           0x0000
#define LIGHT6_ALS_CONFIG_ALS_CAL_ON            0x0001
#define LIGHT6_ALS_CONFIG_ALS_CAL_MASK          0x0001

#define LIGHT6_INT_FLAG_AF_DATA_READY           0x08
#define LIGHT6_INT_FLAG_ALS_IF_L                0x04
#define LIGHT6_INT_FLAG_ALS_IF_H                0x02

#define LIGHT6_DEVICE_ID                        0x0001

#define LIGHT6_ALS_MIN_RES                      0.002568f

#define LIGHT6_ALS_CONFIG_DEFAULT               ( LIGHT6_ALS_CONFIG_ALS_IT_25_MS | \
                                                  LIGHT6_ALS_CONFIG_ALS_MODE_AUTO | \
                                                  LIGHT6_ALS_CONFIG_ALS_TRIGGER_OFF | \
                                                  LIGHT6_ALS_CONFIG_ALS_INT_OFF | \
                                                  LIGHT6_ALS_CONFIG_ALS_ON_TURN_ON | \
                                                  LIGHT6_ALS_CONFIG_ALS_PDDIV_4_4_PD | \
                                                  LIGHT6_ALS_CONFIG_ALS_GAIN_X1 | \
                                                  LIGHT6_ALS_CONFIG_ALS_PERS_8 | \
                                                  LIGHT6_ALS_CONFIG_ALS_CAL_ON )
#define LIGHT6_THRESHOLD_LOW_DEFAULT            0x0000
#define LIGHT6_THRESHOLD_HIGH_DEFAULT           0x0000

#define LIGHT6_DEVICE_ADDRESS                   0x29
 // light6_set



#define LIGHT6_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 // light6_map // light6

typedef struct
{
    // Input pins
    digital_in_t int_pin;       
 
    // Modules
    i2c_master_t i2c;           
 
    // I2C slave address
    uint8_t slave_address;      
 
    float als_res;              
 
} light6_t;

typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
 
    pin_name_t int_pin;         
 
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
 
} light6_cfg_t;

typedef enum
{
    LIGHT6_OK = 0,
    LIGHT6_ERROR = -1
 
} light6_return_value_t;


void light6_cfg_setup ( light6_cfg_t *cfg );

err_t light6_init ( light6_t *ctx, light6_cfg_t *cfg );

err_t light6_default_cfg ( light6_t *ctx );

err_t light6_generic_write ( light6_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );

err_t light6_generic_read ( light6_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );

uint8_t light6_get_int_pin ( light6_t *ctx );

err_t light6_check_communication ( light6_t *ctx );

err_t light6_set_als_config ( light6_t *ctx, uint16_t config );

err_t light6_get_als_config ( light6_t *ctx, uint16_t *config );

err_t light6_set_als_threshold ( light6_t *ctx, uint16_t threshold_low, uint16_t threshold_high );

err_t light6_get_als_threshold ( light6_t *ctx, uint16_t *threshold_low, uint16_t *threshold_high );

err_t light6_get_int_flag ( light6_t *ctx, uint8_t *int_flag );

err_t light6_get_raw_data ( light6_t *ctx, uint16_t *als_data, uint16_t *ir_data );

err_t light6_get_data ( light6_t *ctx, float *als_data, uint16_t *ir_data );
 
#ifdef __cplusplus
}
#endif
#endif // LIGHT6_H
 // light6
 
// ------------------------------------------------------------------------ END